refactor: Agent framework v2 changes. by Pavan-Microsoft · Pull Request #796 · microsoft/Conversation-Knowledge-Mining-Solution-Accelerator

Pavan-Microsoft · 2026-03-04T12:29:15Z

Purpose

This pull request introduces several updates to the documentation and infrastructure configuration to support the new agent creation workflow, improve parameter clarity, and enhance integration with the Azure AI Agent Framework. The changes affect deployment scripts, environment variable management, and instructional guides, making it easier for users to set up and customize the solution with agents and other AI components.

Documentation and Workflow Updates:

Added instructions and scripts for creating AI agents as part of the post-deployment and setup workflow, including updates to AVMPostDeploymentGuide.md, DeploymentGuide.md, and azure.yaml, and clarified the order of setup steps. [1] [2] [3] [4] [5]
Updated environment variable documentation to include new agent and framework parameters, clarifying how these are set during deployment and agent creation (LocalDevelopmentSetup.md). [1] [2]

Infrastructure and Parameter Improvements:

Refactored Azure AI Search connection naming for clarity and consistency across outputs and modules in infra/main.bicep, and updated related outputs for agent and API app names. [1] [2] [3] [4] [5] [6]
Updated processing scripts and documentation to include new parameters for agent endpoints and solution names, improving usability and extensibility for custom data workflows (DeploymentGuide.md, CustomizeData.md, AVMPostDeploymentGuide.md). [1] [2] [3] [4]

Security and Architecture Documentation:

Revised security guidelines to emphasize managed identity usage and removed references to Azure Key Vault as a required component, reflecting architectural changes. [1] [2]
Updated the solution overview and architecture documentation to include the Azure AI Agent Framework and clarify service roles.

Miscellaneous:

Updated Bicep template metadata to reflect the latest version and template hash.

Does this introduce a breaking change?

Yes
No

Golden Path Validation

I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

I have validated the deployment process successfully and all services are running as expected with this change.

… scripts and configuration

…emove unused agent factory classes, streamline ChatService and HistoryService, and enhance SQLTool for better database interaction. Update API routes and configuration management for improved clarity and performance. Upgrade dependencies in requirements.txt for compatibility with new Azure SDK versions.

…gin, ChatService, HistoryService, and App - Removed test cases for deprecated agent factories in test_app.py. - Updated test cases in test_chat_with_data_plugin.py to reflect changes in the ChatWithDataPlugin implementation. - Refactored test cases in test_chat_service.py to remove dependencies on mock requests and streamline the setup. - Enhanced test_generate_title in test_history_service.py to utilize the new v2 agent framework. - Improved error handling tests in test_chat_service.py for rate limits and general exceptions. - Consolidated mock setups and assertions for clarity and maintainability.

…essing

…lation and access

…security in ChatService and HistoryService

…for script

…onversation-Knowledge-Mining-Solution-Accelerator into km-agentframework-v2

…edge-Mining-Solution-Accelerator into km-agentframework-v2

…ntication

…steps in Deployment Guide

…edge-Mining-Solution-Accelerator into km-agentframework-v2

- Updated 00_create_sample_data_files.py to improve CSV and JSON export functions, ensuring better error handling and code readability. - Modified 01_create_search_index.py to include additional whitespace for consistency. - Enhanced 03_cu_process_data_text.py by implementing asynchronous processing for embeddings and agent creation, improving performance and scalability. - Updated 04_cu_process_custom_data.py to streamline the search index creation process and improve error handling. - Adjusted requirements.txt to include new agent framework dependencies and ensure compatibility. - Enhanced process_sample_data.sh and run_create_index_scripts.sh to support new solution_name parameter for better configuration management.

…using names

…clarity

…data

…processing scripts

…d parameter files

Copilot

Pull request overview

Refactors the solution to align with the Azure AI Agent Framework v2 workflow by removing the v1 agent-factory lifecycle, shifting agent usage to per-request AI Project clients/providers, and updating infra scripts/docs to create/configure agents post-deployment.

Changes:

Removed Semantic Kernel-based agent factories and FastAPI lifespan initialization; updated ChatService/HistoryService to use azure.ai.projects.aio + agent_framework.azure providers.
Added/updated deployment & post-deployment scripts to create agents and propagate agent names into App Service / azd env, plus updated infra outputs and docs.
Updated tests and dependencies to reflect the v2 SDK and revised request/response behavior (including citation content/title handling).

Reviewed changes

Copilot reviewed 49 out of 49 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
src/tests/test_app.py	Simplifies app fixture now that lifespan agent factories were removed.
src/tests/api/services/test_history_service.py	Updates title-generation tests to mock Agent Framework v2 components.
src/tests/api/services/test_chat_service.py	Reworks ChatService/ExpCache tests for v2 agent/provider flow and thread deletion.
src/tests/api/plugins/test_chat_with_data_plugin.py	Removes plugin tests tied to deleted v1 plugin/factories.
src/tests/api/agents/test_sql_agent_factory.py	Removes v1 SQL agent factory tests (factory deleted).
src/tests/api/agents/test_search_agent_factory.py	Removes v1 search agent factory tests (factory deleted).
src/tests/api/agents/test_conversation_agent_factory.py	Removes v1 conversation agent factory tests (factory deleted).
src/tests/api/agents/test_chart_agent_factory.py	Removes v1 chart agent factory tests (factory deleted).
src/tests/api/agents/test_base_agent_factory.py	Removes v1 base factory singleton/thread-safety tests (base deleted).
src/api/services/history_service.py	Uses async AIProjectClient + AzureAIProjectAgentProvider to generate titles via a configured title agent.
src/api/services/chat_service.py	Replaces SK streaming/thread model with v2 project client + provider, conversation_id caching, and citation extraction.
src/api/requirements.txt	Updates Azure SDKs and adds agent-framework packages; removes Semantic Kernel dependency.
src/api/plugins/chat_with_data_plugin.py	Deletes SK plugin that depended on removed v1 agent factories.
src/api/common/database/sqldb_service.py	Adds SQLTool wrapper for tool-calling; enforces Entra auth-only DB connectivity.
src/api/common/config/config.py	Adds agent name env vars used by v2 provider-based agent retrieval.
src/api/app.py	Removes lifespan-based agent initialization/cleanup.
src/api/api/api_routes.py	Instantiates ChatService without Request state; adjusts citation fetch endpoint response shape.
src/api/agents/sql_agent_factory.py	Deletes v1 SQL agent factory implementation.
src/api/agents/search_agent_factory.py	Deletes v1 search agent factory implementation.
src/api/agents/conversation_agent_factory.py	Deletes v1 conversation agent factory implementation.
src/api/agents/chart_agent_factory.py	Deletes v1 chart agent factory implementation.
src/api/agents/agent_factory_base.py	Deletes v1 base factory singleton helper.
src/api/.env.sample	Adds new env vars for v2 agent naming and foundry/app metadata.
src/App/src/components/Citations/Citations.tsx	Stores fetched citation title in UI state along with content.
infra/scripts/run_create_index_scripts.sh	Passes solution name through to processing script.
infra/scripts/run_create_agents_scripts.sh	New script: creates agents, toggles Foundry public access if needed, updates App Service and azd env.
infra/scripts/process_sample_data.sh	Adds solution name to required values and passes it into index script runner.
infra/scripts/process_custom_data.sh	Adjusts arg ordering and adds solution name; passes into custom processing script.
infra/scripts/index_scripts/requirements.txt	Aligns index scripts with v2 projects/agents + agent-framework packages.
infra/scripts/index_scripts/04_cu_process_custom_data.py	Migrates embedding + topic mining/mapping logic to async clients and temporary agents (v2).
infra/scripts/index_scripts/03_cu_process_data_text.py	Migrates embedding + topic mining/mapping logic to async clients and temporary agents (v2).
infra/scripts/index_scripts/01_create_search_index.py	Minor formatting/whitespace update.
infra/scripts/index_scripts/00_create_sample_data_files.py	Refactors imports/formatting; removes timestamped filenames.
infra/scripts/agent_scripts/requirements.txt	New minimal requirements for agent creation scripts.
infra/scripts/agent_scripts/01_create_agents.py	New script to create conversation + title agents (and output their names).
infra/main.waf.parameters.json	Updates default image tag to `latest_afv2`.
infra/main.parameters.json	Updates default image tag to `latest_afv2`.
infra/main.json	Updates generated template metadata; introduces AI Search connection name var and new outputs/appsettings.
infra/main.bicep	Adds AI Search connection name, emits new outputs/appsettings for agent creation workflow.
documents/LocalDevelopmentSetup.md	Documents new v2 environment variables and agent-creation step.
documents/DeploymentGuide.md	Adds explicit agent creation step prior to sample data processing.
documents/CustomizingAzdParameters.md	Updates default image tag documentation to `latest_afv2`.
documents/CustomizeData.md	Updates custom data script parameter ordering and adds solution name.
documents/AVMPostDeploymentGuide.md	Reorders post-deploy steps: create agents, then process sample/custom data.
azure.yaml	Updates post-provision messaging to include agent creation script.
README.md	Updates solution description/security guidance to reflect Agent Framework and MI-centric setup.
.github/workflows/job-azure-deploy.yml	Switches main/default image tag from `latest_waf` to `latest_afv2`.
.github/workflows/docker-build.yml	Switches main image tag to `latest_afv2`.
.github/workflows/deploy-KMGeneric.yml	Switches main/default image tag to `latest_afv2`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…ss Bicep, JSON, and script files

…ved async handling

…ON formatting

…ed efficiency

…ctivating Python virtual environment

github-actions · 2026-03-10T11:43:58Z

🎉 This PR is included in version 3.18.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Pavan-Microsoft and others added 30 commits December 4, 2025 11:12

fix: update ODBC Driver references from version 17 to 18 across setup…

c687780

… scripts and configuration

fix: ensure valid chunk text before yielding response in ChatService

bce02f4

fix: comment out citation collection logic in ChatService stream proc…

8b428fc

…essing

fix: refactor thread cache management in ChatService for improved iso…

572f684

…lation and access

fix: update Azure credential retrieval to use client ID for improved …

7a5223c

…security in ChatService and HistoryService

add agent creation python script and update deployment documentation …

c1649d1

…for script

generated main.json

94cf6e3

Merge branch 'km-agentframework-v2' of https://github.com/microsoft/C…

d908a93

…onversation-Knowledge-Mining-Solution-Accelerator into km-agentframework-v2

Merge branch 'dev' of https://github.com/microsoft/Conversation-Knowl…

4868365

…edge-Mining-Solution-Accelerator into km-agentframework-v2

Merge branch 'dev' of https://github.com/microsoft/Conversation-Knowl…

9363ddc

…edge-Mining-Solution-Accelerator into km-agentframework-v2

fix: Update Azure CLI login method to use device code for local authe…

f5e6fcf

…ntication

fix: Update VS Code Web instructions and add dependency installation …

0f29f2f

…steps in Deployment Guide

fix: Clarify deployment time estimate in Deployment Guide

8ff3601

Merge branch 'dev' of https://github.com/microsoft/Conversation-Knowl…

89eea3d

…edge-Mining-Solution-Accelerator into km-agentframework-v2

Merge branch 'dev' of https://github.com/microsoft/Conversation-Knowl…

57ee604

…edge-Mining-Solution-Accelerator into km-agentframework-v2

Merge branch 'dev' of https://github.com/microsoft/Conversation-Knowl…

81c068b

…edge-Mining-Solution-Accelerator into km-agentframework-v2

fix to manage AI Foundry public network access during agent creation

cdcd727

fix: update agent framework package names in requirements.txt

57cf67d

Merge branch 'dev' of https://github.com/microsoft/Conversation-Knowl…

a550a0c

…edge-Mining-Solution-Accelerator into km-agentframework-v2

Merge branch 'dev' of https://github.com/microsoft/Conversation-Knowl…

167e1a7

…edge-Mining-Solution-Accelerator into km-agentframework-v2

fix: Update script variables and enhance processing with agent framework

1eec912

fix: Correct agent deletion by using agent names instead of IDs

ca03047

fix: Refine topic mapping instructions and improve agent deletion by …

5d244e2

…using names

fix: Update topic guidelines to include additional common topics for …

78e5e5e

…clarity

fix: Enhance topic mining by extracting common topics from processed …

0a802ea

…data

fix: Improve exception handling and clean up code formatting in data …

08efc7e

…processing scripts

fix: Correct parameter order in configuration examples for clarity

c8af804

Update image tag references to latest_afv2 in deployment workflows an…

e80a7c6

…d parameter files

Pavan-Microsoft temporarily deployed to production March 4, 2026 12:41 — with GitHub Actions Inactive

Pavan-Microsoft requested a review from Copilot March 4, 2026 12:42

Copilot started reviewing on behalf of Pavan-Microsoft March 4, 2026 12:42 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

Refactor AI Foundry resource ID references to standardize naming acro…

c758670

…ss Bicep, JSON, and script files

Pavan-Microsoft temporarily deployed to production March 4, 2026 13:11 — with GitHub Actions Inactive

Refactor credential patching in test cases to use AsyncMock for impro…

f57f06f

…ved async handling

Pavan-Microsoft temporarily deployed to production March 4, 2026 13:17 — with GitHub Actions Inactive

Refactor citation list construction to use json.dumps for improved JS…

04c8348

…ON formatting

Pavan-Microsoft temporarily deployed to production March 4, 2026 13:38 — with GitHub Actions Inactive

Pavan-Microsoft marked this pull request as ready for review March 4, 2026 13:58

Pavan-Microsoft requested review from Avijit-Microsoft, Prajwal-Microsoft, Roopan-Microsoft, Vinay-Microsoft, aniaroramsft, brittneek, dgp10801, nchandhi and toherman-msft as code owners March 4, 2026 13:58

Pavan-Microsoft temporarily deployed to production March 4, 2026 13:58 — with GitHub Actions Inactive

Refactor topic mapping agent calls to reuse agent instance for improv…

0cfa0e2

…ed efficiency

Pavan-Microsoft temporarily deployed to production March 4, 2026 14:32 — with GitHub Actions Inactive

Refactor AVM Post Deployment Guide to update steps for creating and a…

67f9f46

…ctivating Python virtual environment

Pavan-Microsoft temporarily deployed to production March 5, 2026 04:33 — with GitHub Actions Inactive

Avijit-Microsoft approved these changes Mar 5, 2026

View reviewed changes

Avijit-Microsoft merged commit 88ee0c8 into dev Mar 5, 2026
5 checks passed

github-actions Bot added the released label Mar 10, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: Agent framework v2 changes.#796

refactor: Agent framework v2 changes.#796
Avijit-Microsoft merged 64 commits into
devfrom
km-agentframework-v2

Pavan-Microsoft commented Mar 4, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Mar 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

Pavan-Microsoft commented Mar 4, 2026

Purpose

Does this introduce a breaking change?

Golden Path Validation

Deployment Validation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Mar 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants